Add `goauth` binary for `GOAUTH` environment support #22

fkollmann · 2025-02-12T07:28:12Z

This adds support for the new GOAUTH environment variable, introduced by Go 1.24.

Note: I have not tested the service account support, but it should work. Please feel free to contribute some testing ;) .

Fixes #21

How I tested (binary)

Run go build in cmd/goauth
export GOAUTH="/home/felix/Projects/artifact-registry-go-tools/cmd/goauth/goauth europe-west1"
go get -u golang.org/x/net

How I tested (script)

export GOAUTH="sh -c 'GOPROXY=direct go run github.com/smartpricer/artifact-registry-go-tools/cmd/goauth@latest europe-west1'" (obviously using the fork)
go get -u golang.org/x/net

cmd/goauth/main.go

(for safety for the second call, but this should not happen as this requires the location to be missing, which would fail on the first call.)

yihanzhen

Really appreciate the contribution. Sorry if I am being a little nit picky here; mostly wanted to share some thoughts from the maintainability perspective.

Happy to discuss over the comments.

yihanzhen · 2025-02-14T20:04:01Z

cmd/goauth/main.go

+
+  export GOAUTH="sh -c 'GOPROXY=direct go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>'"
+
+To support multiple locations, add the command multiple times to the GOAUTH variable (semicolon-separated).


Can we add an example for using this together with a non Artifact Registry repo? e.g.,

To support an Artifact Registry repo together with other repos, add all commands to the GOAUTH variable. For example: export GOAUTH="GOPROXY=direct go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>; another command"

I am not against it, but your example won't work, see below. Please feel free to do some testing and verification on your side.

yihanzhen · 2025-02-14T20:06:08Z

cmd/goauth/main.go

+
+Add to your GOAUTH environment variable:
+
+  export GOAUTH="sh -c 'GOPROXY=direct go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>'"


I wonder if we can leave out sh -c. Without it the command should still work but not sure if sh -c works on Windows?

It won't work on Windows and I doubt sh -c is also needed.

Suggested change

export GOAUTH="sh -c 'GOPROXY=direct go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>'"

export GOAUTH="go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>"

must work allright

It won't work on Windows and I doubt sh -c is also needed.

must work allright

No, it does not. Please feel free to do some testing and verification.

I already checked these scenarios:

export GOAUTH="go run github.com/smartpricer/artifact-registry-go-tools/cmd/goauth@latest europe-west1" #--> recursive call export GOAUTH="GOPROXY=direct go run github.com/smartpricer/artifact-registry-go-tools/cmd/goauth@latest europe-west1" #--> 401, does not work export GOAUTH="sh -c 'GOPROXY=direct go run github.com/smartpricer/artifact-registry-go-tools/cmd/goauth@latest europe-west1'" #--> works fine

Regarding the Windows support: Feel free to suggest an example for Windows, after testing it.

Maybe the instructions must change to ask users to run go install first instead of go run

If you install the binary first like this:

GOPROXY=direct go install github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest

Then you can use the installed binary directly in GOAUTH without having to use GOPROXY

GOAUTH="goauth europe-west1"

Even better would be for this to be distributed with the gcloud SDK like the docker Auth does.

I think if going with @cagataygurturk , it needs to be renamed, e.g. go-auth-google-artifact-registry or go-auth-gar or sth. like this.

Besides that, I kind of agree with @owenhaynes , that this should become part of the Google Cloud SDK.

On our side, we solved this easily, because we run a mono repository, so we already have a place to put team-wide tooling.

Even better would be for this to be distributed with the gcloud SDK like the docker Auth does.

I had the same thought - but the original rationale of implementing auth helpers in the same language as the repository format is that the users won't have a dependency on gcloud SDK in their build flow, and some customers do care about this mostly because gcloud is huge.

That being said I think implementing it within gcloud is indeed simpler; I'll go ahead and do that first to hopefully unblock folks. I would like to eventually add support for it in this auth tool, but I think it would require some design review among the team so I'll get back to it later.

FYI after spending a lot of time debugging what's described in golang/go#71889 I finally have made it to work locally. Need some extra time adding tests and stuff and this should be available very soon.

yihanzhen · 2025-02-14T20:16:54Z

cmd/goauth/main.go

+For more details, see https://pkg.go.dev/cmd/go@master#hdr-GOAUTH_environment_variable`
+
+func main() {
+	jsonKey := flag.String("json_key", "", "path to the json key of the service account used for this location. Leave empty to use the oauth token instead.")


I was wondering if we could reuse the same program entry point. The main motivation is to avoid duplicate code (the two flags here), or at least make it harder for future developers to miss one another when adding more features to goauth or netrc.

maybe

export GOAUTH="GOPROXY=direct go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@latest goauth ---location"

I think it's better to have it separate, because the application behavior is dictated by Go and will have to be different from the auth command behavior: Things like writing and reading from stdin/out and getting an additional commandline argument.

Even if they seem to be similar now, they probably will divert more in the future.

cmd/goauth/main.go

cagataygurturk · 2025-02-15T02:44:12Z

cmd/goauth/main.go

+
+Add to your GOAUTH environment variable:
+
+  export GOAUTH="sh -c 'GOPROXY=direct go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>'"


It won't work on Windows and I doubt sh -c is also needed.

Suggested change

export GOAUTH="sh -c 'GOPROXY=direct go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>'"

export GOAUTH="go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>"

must work allright

fkollmann · 2025-02-16T08:00:34Z

fyi, I submitted a change to Go for adding environment variable support: https://go-review.googlesource.com/c/go/+/650055

This should make sh -c obsolete and improve Windows compatibility.

Add goauth binary for GOAUTH environment support

1f89d5d

owenhaynes reviewed Feb 12, 2025

View reviewed changes

cmd/goauth/main.go Outdated Show resolved Hide resolved

Change ignoring URLs as location

d95b5bb

(for safety for the second call, but this should not happen as this requires the location to be missing, which would fail on the first call.)

yihanzhen reviewed Feb 14, 2025

View reviewed changes

cagataygurturk suggested changes Feb 15, 2025

View reviewed changes

fkollmann added 2 commits February 15, 2025 16:55

Change help to be written to stderr

ed04de5

Add unit testing

0a36049

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `goauth` binary for `GOAUTH` environment support #22

Add `goauth` binary for `GOAUTH` environment support #22

fkollmann commented Feb 12, 2025

yihanzhen left a comment •

edited

Loading

yihanzhen Feb 14, 2025

fkollmann Feb 15, 2025

yihanzhen Feb 14, 2025

cagataygurturk Feb 15, 2025

fkollmann Feb 15, 2025

fkollmann Feb 15, 2025

cagataygurturk Feb 16, 2025

owenhaynes Feb 17, 2025

fkollmann Feb 17, 2025

yihanzhen Feb 18, 2025 •

edited

Loading

yihanzhen Feb 24, 2025

yihanzhen Feb 14, 2025 •

edited

Loading

fkollmann Feb 15, 2025

cagataygurturk Feb 15, 2025

fkollmann commented Feb 16, 2025


		export GOAUTH="sh -c 'GOPROXY=direct go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>'"

		To support multiple locations, add the command multiple times to the GOAUTH variable (semicolon-separated).


		Add to your GOAUTH environment variable:

		export GOAUTH="sh -c 'GOPROXY=direct go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>'"

	export GOAUTH="sh -c 'GOPROXY=direct go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>'"
	export GOAUTH="go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/goauth@latest <location>"

Add goauth binary for GOAUTH environment support #22

Are you sure you want to change the base?

Add goauth binary for GOAUTH environment support #22

Conversation

fkollmann commented Feb 12, 2025

How I tested (binary)

How I tested (script)

yihanzhen left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yihanzhen Feb 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yihanzhen Feb 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fkollmann commented Feb 16, 2025

Add `goauth` binary for `GOAUTH` environment support #22

Add `goauth` binary for `GOAUTH` environment support #22

yihanzhen left a comment •

edited

Loading

yihanzhen Feb 18, 2025 •

edited

Loading

yihanzhen Feb 14, 2025 •

edited

Loading